// Thud - a dynamic object-oriented language
// Copyright (C) 2009,2010 David H. Hovemeyer <david.hovemeyer@gmail.com>

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

/*
 * Location.h
 *
 *  Created on: Dec 3, 2009
 *      Author: dhovemey
 */

#ifndef LOCATION_H_
#define LOCATION_H_

#include <string>

/**
 * A source location.
 */
class Location {
private:
	int m_lineNum;

public:
	/**
	 * Constructor.
	 *
	 * @param lineNum source line number
	 */
	Location(int lineNum);

	/**
	 * Copy constructor.
	 *
	 * @param other another Location
	 */
	Location(const Location &other);

	/** Destructor. */
	~Location();

	/**
	 * Assignment operator.
	 *
	 * @param rhs another Location
	 */
	Location& operator=(const Location &rhs);

	/**
	 * Return true if this location is a "valid" (initialized) one,
	 * false if not.
	 */
	bool isValid() const;

	/**
	 * Return source line number.
	 */
	int getLineNum() const;

	/**
	 * Convert to a string.
	 */
	std::wstring asString() const;
};

#endif /* LOCATION_H_ */
